home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr36 / tyaht_53.zip / YAHTZEE.DOC < prev    next >
Text File  |  1993-05-05  |  23KB  |  502 lines
  1.  
  2.                             TRIPLE   YAHTZEE
  3.  
  4.                                   v5.3
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                          (404) 256-9525 (Data)
  12.                          (404) 705-9104 (Data)
  13.                 (404) 256-9518 (Voice, 9am-9:30pm EST)
  14.  
  15.  
  16.  
  17.  
  18.                                 OVERVIEW
  19.                                 ________
  20.  
  21.  
  22.    Triple Yahtzee is played exactly like the board game. A high score file
  23.    is maintained  (size is controlled from the configuration file). Since
  24.    this game can take a while to play to completion,  a game save feature
  25.    has been included. This feature allows the caller to save the  game
  26.    contents and return to the same game on their next call automatically.
  27.  
  28.  
  29.  
  30.    NOTE: Most errors will be logged to a file called DFRAME.ERR, which is
  31.          created in the directory you run the door from.
  32.  
  33.  
  34.  
  35.                               INSTALLATION
  36.                               ____________
  37.  
  38.  
  39.    Installation is fairly easy and straight-forward. The following steps and
  40.    examples should have you up and running in a very short period of time.
  41.    It is assumed that you are familiar with setting up DOORS on your system.
  42.    To this end, only examples of the configuration file and Door batch file
  43.    are described.
  44.  
  45.       1) Create a directory to hold all YAHTZEE files
  46.  
  47.       2) Unzip TYAHTZxx.ZIP into the the above directory
  48.  
  49.       3) Create a configuration file, with a name of your choice, or
  50.          modify the supplied YAHTZEE.CFG file. A description follows:
  51.  
  52.             **                       Location of System file
  53.  
  54.             SUNRISE-80 BBS           Your BBS Name
  55.  
  56.             Al                       SYSOP's First Name
  57.  
  58.             Lawrence                 Sysop's Last Name
  59.  
  60. |-----------------------------------------------------------------------------|
  61. | READ!     1                        CommPort  \ These 2 lines are required   |
  62. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  63. |-----------------------------------------------------------------------------|
  64.  
  65.             00000000                 Registration Number
  66.  
  67.             50                       Number of Top Score entries.
  68.                                      Minimum = 10, Maximum = 99.
  69.  
  70.         #   2                        Keyboard timeout value in minutes.
  71.                                      If key not depressed for 2 minutes
  72.                                      board is saved and caller is returned
  73.                                      to BBS. Minimum=2, Maximum=5
  74.  
  75.         #   NONE                     Drive:\Path\Filename to contain the
  76.                                      Top Score Bulletin or enter NONE
  77.                                      for NO Bulletin creation.
  78.  
  79.         #   NONE                     Drive:\Path\Filename to contain the
  80.                                      Top Score Bulletin (Color) or enter NONE
  81.                                      for NO Bulletin creation.
  82.  
  83.             1                        Initial setting of the HOTKEY feature.
  84.                                      1=ON, 0=OFF. Default will be 1 if any
  85.                                      other value is encountered.
  86.  
  87.             2                        1 = DO NOT Display the ADOPT-A-DOOR Msg
  88.                                      2 = DO Display the ADOPT-A-DOOR Message
  89.                                      When YAHTZEE is Registerd, this option
  90.                                      will have no effect. This option is for
  91.                                      those Sysops that do not like the
  92.                                      ADOPT-A-DOOR Concept.
  93.  
  94.  
  95.         #   1                        Color of Main Portion of Board
  96.                                      1=Blue, 4=Red, 5=Magenta, 14=Yellow
  97.  
  98.             2                        1=Caller will appear only one time in the
  99.                                        HiScore file
  100.                                      2=Caller can appear any number of times in
  101.                                        then Hiscore file
  102.  
  103.  
  104.     !   #   1                        Number of games allowed each day
  105.                                      (Sysop gets 99 in registered version ONLY!)
  106.  
  107.     !   #   0                        Time Allowed in Door
  108.                                      (0 = BBS call time remaining)
  109.                                      (Sysop = Time Remaining - REG. VERSION)
  110.  
  111.         #   Y                        Y = Allow Sysop to have 99 games
  112.                                      N = Do Not Allow Sysop 99 games
  113.  
  114.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  115.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  116.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  117.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  118.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  119.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  120.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  121.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  122.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  123.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  124.  
  125.     @   #   XXXX/YYYY                 Blackout Range  From/To
  126.     @   #   XXXX/YYYY                 Blackout Range  From/To
  127.     @   #   XXXX/YYYY                 Blackout Range  From/To
  128.     @   #   XXXX/YYYY                 Blackout Range  From/To
  129.     @   #   XXXX/YYYY                 Blackout Range  From/To
  130.  
  131.  
  132.        ** = Replace with ONE of the following:
  133.  
  134. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  135. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  136. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  137.                                    (Note:DOOR.SYS must be in SAME directory)
  138. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  139. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  140. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  141. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  142. C:\BBS\CHAIN.TXT                <- For WWIV systems
  143. C:\BBS\GTUSER.BBS               <- For GT Power
  144.                                    * if using this option you must put the
  145.                                      ComPort # on line 5 and the Node # on
  146.                                      line 6 of the configuration file
  147.  
  148.  
  149.  
  150.         # = Requires registration to change to a different value
  151.         ! = See "Plays Per DAY/DOOR Time" Below
  152.         @ = See "Blackout Periods" Below
  153.  
  154.  
  155.       4) Create a batch file or modify the YAHTZEE file supplied. A
  156.          description of this file follows:
  157.  
  158.             ECHO off
  159.             cd\BBS\DOORS\YAHTZEE      Location of Yahtzee files
  160.             YAHTZEE YAHTZEE.CFG       EXE filename and CFG filename (Name
  161.                                       used in creating file in #3 above)
  162.             CD\BBS
  163.             BOARD
  164.  
  165.  
  166.        5) When running in more than one node, be sure to supply a
  167.           different configuration name for each node (your choice of name).
  168.  
  169.        6) If running with Fossil-based multi-port boards add
  170.            /FD to the line containing the CFG name as follows:
  171.  
  172.                        YAHTZEE YAHTZEE.CFG /FD
  173.  
  174.  
  175.  
  176.                           BLACKOUT PERIODS
  177.                           ________________
  178.  
  179.       Use the Blackout ranges option to define up to 5 time periods during
  180.       which you DO NOT want the Door to be played. If a caller tries to access
  181.       the Door during the Blackout period, they will be shown a message that
  182.       contains ALL the Blackout periods you have defined, and to try the Door
  183.       at a later time.
  184.  
  185.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  186.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  187.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  188.  
  189.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  190.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  191.                    a Blackout range.
  192.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  193.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  194.             NOTE: There should be NO BLANK LINES in the configuration file!
  195.  
  196.  
  197.  
  198.                           PLAYS Per DAY/DOOR Time
  199.                           _______________________
  200.  
  201.       Plays Per Day and Door Time can be controlled several ways:
  202.  
  203.       (1) You can use the Games Per Day, singular option, in the config
  204.           file above. This option, will affect ALL callers whose Security
  205.           Level is NOT defined in any of the 10 optional Security Level/
  206.           Plays Per Day entries in the config file.
  207.  
  208.       (2) You can use the Door Time, singular option, in the config file
  209.           above. This option, will affect ALL callers whose Security
  210.           Level is NOT defined in any of the 10 optional Security Level/
  211.           Plays Per Day/Door Time entries in the config file.
  212.  
  213.       (3) You can restrict the number of games a specific Security Level
  214.           will be allowed to play per day or REWARD specific Levels with
  215.           more Plays Per Day.
  216.  
  217.           Likewise, you can restrict the Play time for a specific Security
  218.           Level or REWARD specific Levels with more Door Time.
  219.  
  220.           These options are handled by the use of the 10 config
  221.           entries (000=00/00).
  222.  
  223.           The format of each entry is as follows:
  224.  
  225.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  226.                      where =  is a constant and MUST be included
  227.                      where YY is the # of games per day (must be 2 digits)
  228.                      where / is a constant and MUST be included
  229.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  230.  
  231.           If the callers Security Level is NOT defined, his/her Plays Per
  232.           Day and Door Time will be controlled by the values in items
  233.           (1) and (2), above, respectively..
  234.  
  235.           You may define up to 10 Security Levels. All unused entries must
  236.           be defined as   000=00/00
  237.         --------------------------------------------------------------------
  238.           Example: Suppose you had 3 Security Levels defined on your BBS as
  239.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  240.           wanted to set Plays Per Day as :     Subscriber=5
  241.                                            Visiting Sysop=2
  242.                                                   CoSysop=3
  243.                                                    Friend=10
  244.  
  245.           and Door Time as follows:     Subscriber=30 minutes
  246.                                     Visiting Sysop=20 minutes
  247.                                            CoSysop=10 minutes
  248.                                             Friend=remaining call time
  249.  
  250.  
  251.           You would set the Individual "Games per Day" config entry to 1 and
  252.           the individual "Door Time" to 5 minutes (these would be the
  253.           default number of games and default Time for all Security Levels
  254.           other than 20,30 or 40... make them any number you want). Next you
  255.           would replace 4 of the Security Level entries as :  020=05/30
  256.                                                               030=02/20
  257.                                                               040=03/10
  258.                                                               090=10/0
  259.  
  260.  
  261.                         NON-STANDARD COM SUPPORT
  262.                         ________________________
  263.  
  264.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  265.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  266.       number after the configuration filename. Let's assume your Door is
  267.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  268.       passed to your Door would be:
  269.  
  270.                             FOOBAR FOOBAR.CFG /5
  271.  
  272.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  273.       normally used with COM1. No /x parameter is needed for the standard
  274.       IRQ's.
  275.  
  276.       As an alternative, you may use an environmental variable on the command
  277.       line. To use the variable (following the example above), place a
  278.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  279.       different IRQ number for each node). The command line would now look
  280.       like this:
  281.  
  282.                           FOOBAR FOOBAR.CFG /%IRQ%
  283.  
  284.       This, in combination with the use of the environmental variables
  285.       described in the MULTI-NODE SETUP section will allow you to use one
  286.       batch file and one config file to run this door on all nodes.
  287.  
  288.  
  289.  
  290.  
  291.                            MULTI-NODE SETUP
  292.                            ________________
  293.  
  294.       All Sunrise Doors are Multi-Node capable. Each node must have the
  295.       ability to access a configuration file which will have its own system
  296.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  297.       line. There are 2 ways to accomplish this:
  298.  
  299.       (1) Create a separate configuration file for each node. The only
  300.           difference between each file would be the location of the system
  301.           file for that particular node. For example, on my system there are 2
  302.           nodes and the first line of the config files would look like this:
  303.  
  304.                         NODE1:  H:\PCB1\DOOR.SYS
  305.                         NODE2:  H:\PCB2\DOOR.SYS
  306.  
  307.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  308.  
  309.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  310.           the following PCBoard environmental variables:
  311.  
  312.                  PCBDIR    (Directory containing the System file)
  313.                  PCBDRIVE  (Drive containing the System file)
  314.  
  315.           Thus, the first line of the SINGLE configuration file, for this Door
  316.           would look like this:
  317.  
  318.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  319.  
  320.       NOTE: This option, as described, assumes that you are running PCBoard
  321.             14.5a software. The environmental variables are automatically
  322.             created by the software for each node.
  323.  
  324.             HOWEVER, if you are running other BBS software you should be able
  325.             to set the variables EXACTLY as described below, for EACH node
  326.             (more than likely in each batch file you use to bring up EACH node):
  327.  
  328.                             PCBDRIVE=C:
  329.                             ^^^^^^^^^
  330.                             PCBDIR=\NODE2
  331.                             ^^^^^^^^
  332.  
  333.             Info with a carat (^) under it, MUST be typed as is. The rest
  334.             depends on your naming conventions.
  335.  
  336.             This, in combination with the use of the optional environmental
  337.             variable described in the NON-STANDARD COM SUPPORT section, will
  338.             allow you to use one batch file and one config file to run this
  339.             door on all nodes.
  340.  
  341.  
  342.  
  343.  
  344.                       UPLOADED SCORE UPDATING(PC-YAHTZEE)
  345.                       ___________________________________
  346.  
  347.  
  348.     Triple Yahtzee's companion program, PC-YAHTZEE, is used by your callers
  349.     to play Triple Yahtzee offline on their PC's. When they register PC-YAHTZEE,
  350.     they unlock the ability to upload their scores to your BBS. You in turn
  351.     combine all uploaded scores and merge them into your BBS' Triple Yahtzee
  352.     high score file. You have the option to implement this feature or not.
  353.  
  354.     Your callers will be uploading numeric filenames with .UPL as the
  355.     extension (ex: 12345678.UPL). You can have them upload them to a private
  356.     upload directory or to your regular upload directory. If you choose the
  357.     regular upload directory, then be sure you allow uploads with a .UPL
  358.     extension. The uploaded filename is a fixed format, unique to each user
  359.     of PC-YAHTZEE. Be sure to let your callers know how/where to upload their
  360.     Yahtzee High Score files !
  361.  
  362.     I would appreciate your posting the latest PC-YAHTZEE program as I believe
  363.     it will benefit the throughput of your board, by reducing the amount of
  364.     time spent playing Triple Yahtzee. Please be sure to download a copy for
  365.     yourself and POST one on your BBS!!!
  366.  
  367.     Should you decide to implement (and I would suggest that you do), use the
  368.     following batch file (modify where appropriate) to automate this updating
  369.     process.
  370.  
  371.  
  372.            (1) D:
  373.            (2) CD\NEWUPLD
  374.            (3) COPY *.UPL YAHTZEE.CMB
  375.            (4) DEL *.UPL
  376.            (5) COPY YAHTZEE.CMB C:\PCB\DOORS\YAHTZEE3\
  377.            (6) DEL YAHTZEE.CMB
  378.            (7) C:
  379.            (8) CD\C:\PCB\DOORS\YAHTZEE3
  380.            (9) YAHTZMRG YAHTZEE.CFG
  381.           (10) DEL YAHTZEE.CMB
  382.  
  383.      (1) Change to D: drive
  384.      (2) Change to directory containing the uploaded score files
  385.      (3) Merge all .UPL files into YAHTZEE.CMB (DO NOT rename YAHTZEE.CMB !!!)
  386.      (4) Delete uploaded files (*.UPL)
  387.      (5) Copy YAHTZEE.CMB to Triple Yahtzee door directory
  388.      (6) Delete YAHTZEE.CMB from upload directory
  389.      (7) Change to C: drive
  390.      (8) Change to Triple Yahtzee door directory
  391.      (9) Merge uploaded scores with YAHZTEE.SCO file(Use Yahtzee config file)
  392.     (10) Delete YAHTZEE.CMB
  393.  
  394.          NOTE: This can be run in a nightly event process!!
  395.  
  396.     When merging, YAHTZMRG.EXE will reject duplicate entries within the
  397.     uploaded file(s) as well as entries that duplicate existing entries
  398.     in the YAHTZEE.SCO file. The uploaded score file(s) are created by
  399.     PC-YAHTZEE. Any attempt to change these scores with an editor will
  400.     result in YAHTZMRG rejecting them outright.
  401.  
  402.  
  403.  
  404.                                ADOPT-A-DOOR
  405.                                ____________
  406.  
  407.     Having been a Sysop for a number of years, I have had my share of problems
  408.     and frustrations getting financial support for my board's upkeep. A fellow
  409.     Sysop left a message on my board, not long ago, about a concept that was
  410.     being used by several boards around the country.
  411.  
  412.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  413.     would be the same as sending in a donation, only this way it is earmarked
  414.     for registering a particular door. In a way, the user feels he/she is
  415.     "getting something in return". As a Door author I have decided to build
  416.     this concept into each of my Door programs. The concept replaces the
  417.     usual message "tell the Sysop to register this Door" we find in most
  418.     doors.
  419.  
  420.     If the Door is unregisterd then a message appears on the opening screen
  421.     to that effect. After finishing or suspending a game, a message screen
  422.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  423.     caller to contact the Sysop to find out if there is any further details
  424.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  425.     time, etc to callers that ADOPT-A-DOOR.
  426.  
  427.     If the Door has been registered, either by the Sysop or other callers,
  428.     the names of those contributors will be displayed in the closing screen.
  429.  
  430.     NOTE: If you want to display the names of the callers that contributed
  431.           to registering the Door, you must create an ASCII file called
  432.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  433.           the name(s) of the contributors (one on each line, maximum of 5
  434.           entries, each a maximum of 30 characters long). This file must be
  435.           saved, in ASCII format, and placed in the Door directory.
  436.  
  437.  
  438.  
  439.                               LEGALITIES
  440.                               __________
  441.  
  442.  
  443.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  444.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  445.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  446.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  447.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  448.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  449.       OR BREACH OF ANY WARRANTY.
  450.  
  451.  
  452.  
  453.  
  454.  
  455.                              DISTRIBUTION
  456.                              ____________
  457.  
  458.    You may make this file available for downloading from your BBS or you may
  459.    upload it to any BBS of your choice, provided that you do not make any
  460.    changes to the contents of the archive (ZIP file). The archive and its
  461.    individual contents may not be used by any service that charges any money
  462.    whatsoever, without the written permission of the author.
  463.  
  464.  
  465.  
  466.  
  467.  
  468.                              REGISTRATION
  469.                              ____________
  470.  
  471.    Registration and the subsequent insertion of the registration number into
  472.    your configuation file, allows for the display of your BBS name on the
  473.    opening and closing screen as well as the reduction of a delay built into
  474.    the opening screen display along with the ability to change certain values
  475.    in the configuration file.
  476.  
  477.    To register your copy of YAHTZEE, please fill out the registration form
  478.    (REGISTER.FRM) and mail it along with the registration fee to
  479.    the name and address on the form.
  480.  
  481.    Be sure to use the proper upper/lower case when filling in your name and
  482.    BBS name, as they MUST match the way you entered them in the configuration
  483.    file.             ^^^^
  484.  
  485.    Based upon information supplied on the registration form, I will pre-
  486.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  487.    up your registration number or supply a self-addressed stamped envelope.
  488.  
  489.  
  490.  
  491.                                  MISC
  492.                                  ____
  493.  
  494.    The latest version of TRIPLE YAHTZEE and other fine SUNRISE DOOR programs
  495.    are always available for download from SUNRISE-80 BBS and/or SALTAIR BBS.
  496.  
  497.    Remember, should you have any problems, questions or suggestions, be sure
  498.    to drop me a message on either of the aforementioned BBS' or via the
  499.    DOORS conference on PCRELAY/RIME, Node=SUNRISE.
  500.  
  501.  
  502.